Skip to main content
Feedback

Update Source

The Update Source operation updates the name and properties of a specified source under an account accessible to the authenticated user.

To perform this operation, send an HTTP PUT request to

https://api.boomi.com/mdm/api/rest/v1/<accountID>/sources/<sourceID>

This operation requires the authenticating user to have the MDM - Source Management and API Access privileges.

You can implement requests for this operation in processes using the HTTP Client connector.

The body of the request must conform to the following structure:

<mdm:UpdateSourceRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mdm="http://mdm.api.platform.boomi.com/">
   <mdm:name></mdm:name>
   <mdm:entityIdUrl></mdm:entityIdUrl>
</mdm:UpdateSourceRequest>

where

  • <mdm:name> sets the source name. This element is optional. However, if you omit it, then it requires <mdm:entityIdUrl>.

  • <mdm:entityIdUrle> sets the URL template, which uses to construct target URLs for links, rendered in the user interface, to entities in the source system. In the template {id} is the placeholder for the source entity ID. This element is optional, but you omit it, then you must use<mdm:name>.

For example:

<mdm:UpdateSourceRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:mdm="http://mdm.api.platform.boomi.com/">
   <mdm:name>Salesforce</mdm:name>
   <mdm:entityIdUrl>https://na2.salesforce.com/{id}</mdm:entityIdUrl>
</mdm:UpdateSourceRequest>

Path parameters

accountID
ID of the account

sourceID
ID of the source

Responses

  • 200 (OK) If you updated the specified source successfully, the response body contains true.

  • 400 (Bad Request) Omitted the path parameter sourceId from the request URL. Sample response body:

    <error>
        <message>A source ID was not specified.</message>
    </error>

  • 400 (Bad Request) sourceId does not specify a valid source ID. Sample response body:

    <error>
        <message>The specified source ID is invalid.</message>
    </error>

  • 400 (Bad Request) sourceID does not identify a source that exists in the specified account. Sample response body:

    <error>
        <message>A source with ID 'WD' does not exist in this account.</message>
    </error>

  • 400 (Bad Request) The <mdm:name> element in the request body does not contain a valid source name. Sample response body:

    <error>
        <message>The specified source name is invalid.</message>
    </error>

  • 400 (Bad Request) The <mdm:entityIdUrl> element in the request body does not contain a valid entity URL template. Sample response body:

    <error>
        <message>The entity url is invalid.</message>
    </error>

  • 400 (Bad Request) The <mdm:name> and <mdm:entityIdUrl> elements were both omitted from the request body. Sample response body:

    <error>
        <message>A source name or entity ID URL was not specified.</message>
    </error>

  • 403 (Forbidden) Authentication failure. Sample response body:

    <UserMessage id="error.user.login" type="error">
        <Data>Incorrect user name and password combination.</Data>
    </UserMessage>

  • 403 (Forbidden) accountID does not identify an account accessible to the authenticating user. Sample response body:

    <UserMessage id="error.user.login" type="error">
        <Data>Incorrect user name and password combination.</Data>
    </UserMessage>
On this Page